home *** CD-ROM | disk | FTP | other *** search
/ Hottest 6 / Hottest 6 (1996)(PDSoft)[!].iso / software / fredfish / 1032.lha / Programs / ManageCDPics / ManageCDPics.doc < prev    next >
Text File  |  1994-12-21  |  10KB  |  294 lines
  1. Document ManageCDPics
  2.  
  3. ManageCDPics - © 1994 by Markus Hillenbrand
  4. -------------------------------------------
  5.  
  6. ManageCDPics (short: MCDP) is a program to create some kind of picture
  7. database. You can easily have a look at pictures stored in several
  8. databases. The program was written to be mainly used for compact disks.
  9.  
  10. 1. Requirements
  11. ~~~~~~~~~~~~~~~
  12. You need:    - intuition.library    v37
  13.         - gadtools.library    v37
  14.         - graphics.library    v37
  15.         - dos.library        v37
  16.         - exec.library        v37
  17.         - utility.library    v37
  18.         - icon.library        v37
  19.         - datatypes.library    v39 (only for the slideshow)
  20.         
  21. You should also have enough datatypes installed on your system, if you 
  22. want to use the slideshow.
  23.  
  24. 2. Configuration
  25. ~~~~~~~~~~~~~~~~
  26.  
  27. The program can be configured by editing the tooltypes of the program´s
  28. icon. Currently the following tooltypes are supported:
  29.  
  30.     JPG=...        enter the name of the viewer for JPGs
  31.     GIF=...        enter the name of the viewer for GIFs
  32.     OTHER=...    enter the name for any other format
  33.  
  34. These tooltypes can be overridden by ENV: variabled:
  35.  
  36.     MCDPics_G = the same as GIF    in tooltypes
  37.     MCDPics_J = the same as JPG    in tooltypes
  38.     MCDPics_O = the same as OTHER  in tooltypes
  39.  
  40. This is useful for users who start it from a write protected disk
  41. (i.e. a compact disk).
  42.     
  43. The tooltypes SM_xxx_xxx and SM_HIGHER can be edited, too. But it is 
  44. recommended to change them by using the program´s built in menu entry
  45. 'save prefs'.
  46.  
  47. The following tooltypes do only affect the slideshow part of the program:
  48.  
  49.     IGNOREERRORS    delete the brackets '(' and ')' if you do not
  50.             want the program to stop a slideshow when an
  51.             error occurs. An error can be low memory or
  52.             a deletet file, that cannot be loaded.
  53.             add  bracket '(' and ')' if you want to stop
  54.             a slideshow when an error occurs.
  55.  
  56.     DEBUG        if this is enabled (i.e. no brackets, see above)
  57.             the program will open a window where detailed
  58.             error messaged will be printed if an error occurs.
  59.  
  60.     OWNSCREENMODES    if this is enabled, the gadget 'define own screen-
  61.             modes' will be enabled by default.
  62.  
  63. 3. The Program
  64. ~~~~~~~~~~~~~~
  65.  
  66. If you start the program, you can see three listviews and several gadgets.
  67. In the left listview you can select the database you want to have a look
  68. at. The middle one represents the categories in this database. Third there
  69. are the entries in these categories: the pictures.
  70.  
  71. The text gadget in the middle of the window is used to show some text 
  72. related to the picture which is active.
  73.  
  74. Underneath the first listview there is a string gadgets that contains the
  75. calls of the external viewers for the pictures. The contents of this gadgets
  76. depends on the suffix of the picture: if the suffix is '.gif' the call 
  77. defined via the tooltype GIF=... will be shown, if the suffix is '.JPG' the
  78. call for JPGs will be inserted, otherwise there will appear the entry for
  79. OTHERS=... You can change the entries everytime; but don´t forget the '%s':
  80. it will be replaced by the name of the picture. Any change of the entry will
  81. remain until you end the program. You can save your entries by using the menu
  82. 'save prefs'.
  83.  
  84. Next there is a cycle gadget. You can specify 'CD', 'Category' and 'Picture'.
  85. If you select category, all pictures that follow the active one in the third
  86. listview (including the actual) will be affected by your further actions.
  87. If you select CD the whole database will be affected, if you select picture,
  88. only the actual picture is beeing affected.
  89.  
  90. The last gadget is a button. If you click here the picture(s) will be shown
  91. using the external viewer(s).
  92.  
  93. 4. The Menus
  94. ~~~~~~~~~~~~
  95.  
  96. The are two menus attached to the window. The 'Program' and the 'Special' menu.
  97. In the 'Program' menu you can save the prefs, see an about requester or quit
  98. the program.
  99.  
  100. The 'Special' menu lets you enter the slideshow part of the program.
  101.  
  102. 5. The Slideshow
  103. ~~~~~~~~~~~~~~~~
  104.  
  105. A new window pops up containing several gadgets:
  106.  
  107. Define Own Screenmodes:    If active, the program forces the pictures
  108.             into a specified screenmode (see below).
  109.             This is especially useful for graphic cards.
  110.             If you check this gadget, you can specify
  111.             your screenmodes in the list above.
  112.             Every picture with a resolution smaller or 
  113.             equal the dimensions printed in front of the
  114.             text gadgets will be forced to use a screen
  115.             with the new screenmode.
  116.  
  117. Loop:            If this is active, the program won't stop if
  118.             the end of the category or database is reached,
  119.             it will start from the beginning.
  120.  
  121. Time Delay:        0     = wait for mousebutton to show next picture
  122.             3-300 = wait n seconds until showing next picture
  123.  
  124. Start Sildeshow:    well, it's obvious!
  125.             Once you've started the slide show you can stop it
  126.             by pressing the button in the window that appears
  127.             or by sending a CTRL_C to the program's task.
  128.             This slideshow will use the datatypes.library for
  129.             decoding pictures. You will have to install the 
  130.             right classes for the pictures you want to slide.
  131.  
  132. 6. The Database Format
  133. ~~~~~~~~~~~~~~~~~~~~~~ 
  134.  
  135. - All data files must be located in a subdirectory called 'CDS'.
  136.  
  137. - First you have to give the root of your path:
  138.  
  139.     ROOT
  140.         CD0:
  141.     END
  142.  
  143.   Note: Before CD0: you must enter a TAB, no space.
  144.  
  145. - Then you define the categories:
  146.  
  147.        CATEGORIES
  148.         xx
  149.         yy
  150.         ...
  151.     END
  152.  
  153.    Note: Before xx you must enter a TAB, no space.
  154.  
  155. - Then you must define the directory names belonging to every category:
  156.  
  157.           CALLS
  158.         xx-dir
  159.         yy-dir
  160.         ...
  161.     END
  162.  
  163.    Note: Before xx-dir you must enter a TAB, no space.
  164.  
  165. - Now you define the pictures for every category:
  166.  
  167.        xx-dir
  168.         pic1
  169.         description.1
  170.         pic2
  171.         description.2
  172.         ...
  173.     yy-dir
  174.         picx
  175.         description.x
  176.         picy
  177.         description.y
  178.         picz
  179.         description.z
  180.         ...
  181.  
  182.    Note: Before pic.. you must enter a TAB, no space.
  183.          You need not enter END here.
  184.  
  185. Just have a look at the files in CDS, and you will understand how it 
  186. works.
  187.  
  188. 7. The Script MakeNewDataBase
  189. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  190.  
  191. This tool allows you to easily create a new database for the program.
  192. You  can scan directories which must be organized this way:
  193.  
  194.     - All pictures must be placed in subdirectories.
  195.     - only one depth of subdirs is allowed, a subdir of a subdir
  196.           won´t cause trouble, but no pics will be recognized.
  197.     - All files must be pictures, other files are added too.
  198.  
  199. Anyway you can try out the script; it will create something useful, or
  200. you may throw it away and create your database by hand.
  201.  
  202. CAUTION: If the script doesn´t work, please have a look at the protection
  203.          bits of the file 'script.2'; there must appear an 's'. If there
  204.          is no 's', just type in your shell: 'protect script.2 s add',
  205.          and everything should work fine.
  206.  
  207. 8. The Program DTShow
  208. ~~~~~~~~~~~~~~~~~~~~~
  209.  
  210. This program uses datatypes.library to view pictures. You'll need OS3.0
  211. and the monitor drivers 'SUPER72' and 'EURO72' and 'MULTISCAN' installed.
  212. Special Feature: Small pics will be shown in the middle of a screen!!!
  213.  
  214. 9. The Author
  215. ~~~~~~~~~~~~~
  216.  
  217. Here is my address (bug-report, suggestions or something like that, and the 
  218. postcard):
  219.  
  220.     Markus Hillenbrand
  221.     Weserstraße 9
  222.     36124 Eichenzell-Löschenrod
  223.     GERMANY
  224.  
  225.     Tel.: 06659/3176 or 0631/99698
  226.  
  227.     e-mail: m_hillen@informatik.uni-kl.de
  228.         hillenbr@alma.student.uni-kl.de
  229.  
  230. 10. Copyright
  231. ~~~~~~~~~~~~~
  232.  
  233. **********************************************************************
  234. *                                                                    *
  235. *   T   H   I   S          P   R   O   G   R   A   M         I   S   *
  236. *                                                                    *
  237. *    #####   ####   #####   #####   #     #   ####   #####   #####   *
  238. *   #       #    #  #    #  #    #  #     #  #    #  #    #  #       *
  239. *   #       #    #  #    #  #    #  #     #  #    #  #    #  #       *
  240. *   #       ######  #####   #    #  #     #  ######  #####   ###     *
  241. *   #       #    #  # #     #    #  #  #  #  #    #  # #     #       *
  242. *   #       #    #  #  #    #    #  # # # #  #    #  #  #    #       *
  243. *   #       #    #  #   #   #    #  ##   ##  #    #  #   #   #       *
  244. *    #####  #    #  #    #  #####   #     #  #    #  #    #  #####   *
  245. *                                                                    *
  246. **********************************************************************
  247.  
  248. Since version 1.2, MCDP is CARDWARE. So you'll have to send me a postcard
  249. of your country/home/city/... with a few words from you (in your own
  250. language ?) if you use MCDP regularly.
  251.  
  252. MCDP is Copyright (C) 1994 Markus Hillenbrand and it's freely distributable
  253. as long as all of its files are included in their original form without
  254. additions, deletions, or modifications of any kind, and only a nominal fee
  255. is charged for its distribution. This software is provided *AS IS* without
  256. warranty of any kind, either expressed or implied. By using MCDP, you agree
  257. to accept the entire risk as to the quality and performance of the program.
  258.  
  259. Of course, it was tested rather extensively before it was released...
  260.  
  261. 11. Thanks
  262. ~~~~~~~~~~
  263.  
  264. - Marcus Flehmig for beta-testing
  265. - Stephan Sürken for his program 'Text2Guide'
  266. - Christoph Feck for his JFIF datatype
  267.  
  268. 12. History
  269. ~~~~~~~~~~~
  270.  
  271. v1.0:    first official release
  272. v1.1:    added cycle gadget for CD, category, single
  273.     added some databases
  274.     new icons
  275. v1.2:    added slideshow
  276.     added documents
  277.     some bugfixes
  278.     added some databases
  279.  
  280. 13. Future Plans
  281. ~~~~~~~~~~~~~~~~
  282.  
  283. - localization
  284. - program 'EasySlide' for the shell
  285. - thumbnails
  286. - better handling of databases
  287. - appwindow for adding pictures
  288. - sorting of pictures, categories, CDs
  289. - better support for HAM pictures in combination with graphic cards
  290. - support for MPEG
  291.  
  292. And remember: the more cards I get, the faster I will write a new 
  293.               version of the program.
  294.